docs: add :members: to OTLP exporter submodule automodule directives#5124
Open
alliasgher wants to merge 1 commit intoopen-telemetry:mainfrom
Open
docs: add :members: to OTLP exporter submodule automodule directives#5124alliasgher wants to merge 1 commit intoopen-telemetry:mainfrom
alliasgher wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
The trace_exporter, metric_exporter, and _log_exporter entries in docs/exporter/otlp/otlp.rst had no Sphinx autodoc options, so their classes were not included in the generated API documentation. Add :members:, :undoc-members:, and :show-inheritance: to each of the six submodule automodule directives (three for proto.http, three for proto.grpc) so the exporter classes appear on the rendered page. Fixes open-telemetry#2786 Signed-off-by: Ali <alliasgher123@gmail.com>
alliasgher
force-pushed
the
docs/2786-otlp-exporter-api-docs
branch
from
b30a604 to
3abc890
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
trace_exporter,metric_exporter, and_log_exporterentries indocs/exporter/otlp/otlp.rsthad no Sphinx autodoc options, so their classes were not included in the generated API documentation. The top-levelproto.httpandproto.grpcentries already have:members:,:undoc-members:, and:show-inheritance:— the fix applies the same directives to the six submodule entries.Fixes #2786
Type of change
How Has This Been Tested?
Docs-only change. Verified by inspecting the RST and comparing against sibling exporter docs (e.g.
prometheus.rst) that correctly use:members:on eachautomoduledirective.Does This PR Require a Contrib Repo Change?
No.
Checklist
## Unreleased